/*
Copyright [2020] [https://www.stylefeng.cn]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：

1.请不要删除和修改根目录下的LICENSE文件。
2.请不要删除和修改Guns源码头部的版权声明。
3.请保留源码和相关描述文件的项目出处，作者声明等。
4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns-separation
5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns-separation
6.若您的项目无法满足以上几点，可申请商业授权，获取Guns商业授权许可，请在官网购买授权，地址为 https://www.stylefeng.cn
 */
package cn.stylefeng.guns.sys.modular.auth.service;

import cn.stylefeng.guns.core.pojo.login.SysLoginUser;
import cn.stylefeng.guns.core.pojo.response.ResponseData;
import cn.stylefeng.guns.sys.modular.auth.bean.SysRegisterBean;
import cn.stylefeng.guns.sys.modular.user.entity.SysUser;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.security.core.Authentication;

import jakarta.servlet.http.HttpServletRequest;

/**
 * 认证相关service
 *
 * @author xuyuxiang
 * @date 2020/3/11 14:14
 */
public interface AuthService {

    /**
     * 无需密码登录，例如微信扫码登录等，获取到账号后即认为已认证成功，生成token
     *
     * @param account
     * @return token
     * @author wangshaopeng
     * @date 2021/8/2 15:57
     */
    String loginWithNoPwd(String account);

    /**
     * 账号密码登录
     *
     * @param account  账号
     * @param password 密码
     * @return token
     * @author xuyuxiang
     * @date 2020/3/11 15:57
     */
    String login(String account, String password, String locale);

    /**
     * 从request获取token
     *
     * @param request request
     * @return token
     * @author xuyuxiang
     * @date 2020/3/13 11:41
     */
    String getTokenFromRequest(HttpServletRequest request);

    /**
     * 根据token获取登录用户信息
     *
     * @param token token
     * @return 当前登陆的用户信息
     * @author xuyuxiang
     * @date 2020/3/13 11:59
     */
    SysLoginUser getLoginUserByToken(String token);

    /**
     * 退出登录
     *
     * @author xuyuxiang
     * @date 2020/3/16 15:03
     */
    void logout();

    /**
     * 设置SpringSecurityContext上下文，方便获取用户
     *
     * @param sysLoginUser 当前登录用户信息
     * @author xuyuxiang
     * @date 2020/3/19 19:59
     */
    void setSpringSecurityContextAuthentication(SysLoginUser sysLoginUser);

    /**
     * 获取SpringSecurityContext中认证信息
     *
     * @return 认证信息
     * @author xuyuxiang
     * @date 2020/3/19 20:02
     */
    Authentication getAuthentication();

    /**
     * 校验token是否正确
     *
     * @param token token
     * @author xuyuxiang
     * @date 2020/5/28 9:57
     */
    void checkToken(String token);

    /**
     * 临时缓存租户信息
     *
     * @param tenantCode 多租户编码
     * @author fengshuonan
     * @date 2020/9/3 21:22
     */
    void cacheTenantInfo(String tenantCode);

    /**
     * 根据系统用户构造用户登陆信息
     *
     * @param sysUser 系统用户
     * @return 用户信息
     * @author xuyuxiang
     * @date 2020/9/20 15:21
     **/

    SysLoginUser genSysLoginUser(SysUser sysUser);


    /**
     * 根据用户名检查登录状态
     *
     * @param request request
     * @return token 没有登录或超时为null
     */
    ResponseData checkUserLoginStatus(HttpServletRequest request);

    /**
     * 校验票据, 生成子系统token
     *
     * @param from    子系统来源
     * @param account 用户名
     * @param ticket  票据
     * @return token
     */
    ResponseData clientCheckTicket(String from, String account, String ticket);

    /**
     * 发送注册邮件验证码
     * @param account
     * @param email
     * @param locale
     * @return
     */
    ResponseData<?> sendRegisterEmail(String account, String email, String locale);

    /**
     * 注册用户
     * @param registerBean
     * @return
     */
    ResponseData<?> doRegister(SysRegisterBean registerBean);

    void downloadCertificate(HttpServletResponse response);

    byte[] decrypt(byte[] str, String privateKey) throws Exception;

    ResponseData<?> bindSn(SysRegisterBean registerBean);

    /**
     *@description 同一个IP 5分钟内连续发送验证码超过5次则锁定5分钟
     *@author kongtao
     *@date  2023/12/15 16:20
     **/
    boolean checkIpLimit(String salt);

    /**
     *@description 同一个邮箱5分钟之内仅可以发送一次验证码
     *@author kongtao
     *@date  2023/12/15 14:59
     **/
    boolean checkEmailLimit(String email);

    boolean sendSmtpEmail(String email, String ccEmail, String subject, String message);
    boolean sendEmail(String subject, String body, String recipient, String attachment);

    /**
     *@description 一分钟内请求不能超过5次
     *@author kongtao
     *@date  2024/06/27 15:37
     **/
    boolean checkCountLimit(String salt);
}
